makeinfo

NAME

SYNOPSIS

makeinfo

[-I dir] [-D var] [-U var] [--error-limit num | -e num] [--fill-column num | -f num] [--footnote-style style | -s style] [--no-headers] [--no-split] [--no-validate | --no-pointer-validate] [--no-warn] [--no-number-footnotes | --number-footnotes] [--output file | -o file] [--paragraph-indent num | -p num] [--reference-limit num | -r num] [--verbose] [--version | -V]

DESCRIPTION

See Texinfo, the GNU Documentation Format for details on how to write a texinfo file.

OPTIONS

-I dir

Adds dir to the directory search list for finding files that are included using the `@include' command. By default, makeinfo searches only the current directory.

-D var

Defines the texinfo flag var. This is equivalent to `@set var' in the Texinfo file.

-U var

Makes the texinfo flag var undefined. This is equivalent to `@clear var' in the Texinfo file.

--error-limit num | -e num

Sets the maximum number of errors that makeinfo prints before exiting (on the assumption that continuing would be useless). The default number of errors that can be printed before makeinfo gives up on processing the input file is 100.

--fill-column num | -f num

Specifies the maximum right-hand edge of a line. Paragraphs that are filled will be filled to this width. The default value for fill-column is 72.

--footnote-style style | -s style

Sets the footnote style to style. style should either be `separate' to have makeinfo create a separate node containing the footnotes for the current node, or `end' to have makeinfo place the footnotes at the end of the current node.

--no-headers

Do not generate menus or node headers. This option is useful together with the `--output file' and `--no-split' options to produce a simple formatted file (suitable for printing on a dumb printer) from Texinfo source. If you do not have TeX, these options may allow you to get readable hard copy.

--no-split

Suppress the splitting stage of makeinfo. In general, large output files are split into smaller subfiles, each one approximately 50k bytes. If you specify --no-split, makeinfo will not split up the output file.

--no-validate | --no-pointer-validate

Suppress the validation phase of makeinfo. Normally, after the file is processed, some consistency checks are made to ensure that cross references can be resolved, etc.

--no-warn

Suppress the output of warning messages. This does not suppress the output of error messages, simply warnings. You might want this if the file you are creating has texinfo examples in it, and the nodes that are referenced don't actually exist.

--no-number-footnotes

Supress the automatic numbering of footnotes. The default is to number each footnote sequentially in a single node, resetting the current footnote number to 1 at the start of each node.

--number-footnotes

Explicitly request that footnotes be numbered, as they are by default.

--output file | -o file

Write the output in the file specified, instead of in the name specified in the texinfo file itself. file can be the special token `-', which specifies standard output.

--paragraph-indent num | -p num

Sets the paragraph indentation to num. The value of num is interpreted as follows:

A value of 0 means don't change the existing indentation at the starts of paragraphs.

A value less than zero means indent paragraph starts to column zero by deleting the existing indentation.

A value greater than zero is the number of spaces to leave at the front of each paragraph start.

--reference-limit num | -r num

Issue a warning if any single node is referenced more than num times in the info file. The default num is 1000.

--verbose

Causes makeinfo to inform you as to what it is doing. Normally makeinfo only outputs text if there are errors or warnings.

--version | -V

Prints out the version number of makeinfo.

SEE ALSO

AUTHOR

COPYING

Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.

Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.

Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be included in translations approved by the Free Software Foundation instead of in the original English.

Index

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

SEE ALSO

AUTHOR

COPYING